/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.web.portlet.bean;

import java.util.Map;

import com.genia.toolbox.basics.exception.BundledException;
import com.genia.toolbox.web.portlet.visitor.PortletVisitor;

/**
 * This interface define the base element of a page constructed by portlets.
 */
public interface Portlet
{

  /**
   * The visit method to use with a <code>PortletVisitor</code>.
   * 
   * @param visitor
   *          the <code>PortletVisitor</code>
   * @throws BundledException
   *           when an error occurred.
   */
  public void visit(PortletVisitor visitor)
      throws BundledException;



  /**
   * return the identifier of the current implementation of portlet.
   * 
   * @return the identifier of the current implementation of the portlet
   */
  public String getIdentifier();



  /**
   * getter for the attributes property.
   * 
   * @return the attributes
   */
  public Map<String, String> getAttributes();



  /**
   * getter for the descriptionName property.
   * 
   * @return the descriptionName
   */
  public String getDescriptionName();

}
